Skip to content

Enhance deploy help links and improve scaffold error handling#235

Merged
stiwicourage merged 8 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles
May 24, 2026
Merged

Enhance deploy help links and improve scaffold error handling#235
stiwicourage merged 8 commits into
developfrom
feature/215-refactordeploy-novapackage-align-with-terminal-ux-design-principles

Conversation

@stiwicourage

Copy link
Copy Markdown
Owner

Summary

Affected area

  • nova CLI or command routing
  • Public PowerShell cmdlet behavior
  • Scaffolding or project.json handling
  • Build, test, analyzer, coverage, or CI helper flow
  • Package, raw upload, or package metadata workflow
  • Publish, release, or GitHub Actions automation
  • Self-update or notification preference behavior
  • Contributor documentation (README.md, CONTRIBUTING.md, repository workflow docs)
  • End-user docs (docs/*.html)
  • Command help (docs/NovaModuleTools/en-US/*.md)
  • src/resources/example/
  • Dependency or manifest changes (project.json, workflow dependencies, release tooling)
  • Security-sensitive change
  • Documentation-only change
  • Agentic Copilot Workflow + scaffold mirror + scaffold-sync guardrail test.
  • Other

Review guidance

  • Start with src/private/scaffold/InvokeNovaModuleInitializationWorkflow.ps1, where the staged change adds progress phases and the final next-step summary.
  • Then review src/private/scaffold/InitializeNovaModuleScaffold.ps1 for the clearer stage messages and improved existing-folder recovery guidance.
  • Finish with tests/private/scaffold/*.Tests.ps1 and docs/NovaModuleTools/en-US/Initialize-NovaModule.md to confirm the staged behavior is locked in and documented.
  • Release impact is low: the staged change affects the current 3.0.2-preview line and would flow unchanged into the next stable release, but it does not alter versioning, publish behavior, or GitHub Actions release semantics.

Validation

  • Invoke-NovaBuild
  • Test-NovaBuild
  • ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
  • ./scripts/build/ci/Invoke-NovaModuleToolsCI.ps1
  • Targeted Nova workflow validated (% nova build, % nova test, % nova merge, % nova deploy, % nova publish, % nova release, % nova update, % nova notification, or % nova init as relevant)
  • Docs/example only; executable validation not needed

Validation notes:

pwsh -NoLogo -NoProfile -Command "Invoke-NovaBuild; Import-Module ./dist/NovaModuleTools/NovaModuleTools.psd1 -Force; Test-MarkdownCommandHelp -Path ./docs/NovaModuleTools/en-US/Initialize-NovaModule.md -DetailView"
pwsh -NoLogo -NoProfile -File ./scripts/build/Invoke-ScriptAnalyzerCI.ps1
pwsh -NoLogo -NoProfile -File ./run.ps1

The staged change does not touch release/version/package automation, so no CI release-path validation was needed beyond the normal repository quality loop.

Documentation and release follow-up

  • README.md reviewed and updated if contributor workflow, architecture, CI, release, or automation changed
  • CONTRIBUTING.md reviewed and updated if contribution expectations or review guidance changed
  • CHANGELOG.md reviewed and updated if the change matters to users, maintainers, or contributors
  • RELEASE_NOTE.md reviewed and updated if the change affects public cmdlet usage, CLI usage, configuration semantics, or migration expectations
  • docs/NovaModuleTools/en-US/ help updated if a public command or CLI behavior changed
  • docs/*.html updated if end-user workflows or examples changed
  • src/resources/example/ reviewed and updated if the real-world project layout, package model, or upload workflow changed
  • No documentation, changelog, release-note, or example updates were needed

Maintainability, compatibility, and risk

  • Code Health / maintainability impact considered
  • No breaking change
  • Breaking change
  • Security-sensitive change
  • CI, workflow, or release-pipeline impact
  • Dependency-review impact

Risk, rollout, or rollback notes:

Low risk. The staged change is limited to scaffold UX, mirrored tests, and command help/release text.

Compatibility:
- No parameter, scaffold-content, project.json schema, or release-flow change.
- The scaffold remains interactive; the change only adds progress, clearer completion guidance, and a more actionable folder-exists error.

Rollback:
- Revert the two scaffold helper changes plus the matching test/help/changelog/release-note updates.

 Add source-mirrored, dot-source-first Pester test files for the small
 and well-isolated helpers under src/private/scaffold and
 src/private/update so each unit-level helper has a focused test file
 under tests/private/scaffold or tests/private/update instead of being
 covered only through broad legacy coverage files. The remaining
 workflow-level scaffold and update helpers stay covered by the existing
 broad tests for now.
…package-align-with-terminal-ux-design-principles

* develop:
  Restore and clarify deploy help links and update tests (#234)

# Conflicts:
#	CHANGELOG.md
#	RELEASE_NOTE.md
@github-actions

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gates Passed
6 Quality Gates Passed

See analysis details in CodeScene

Quality Gate Profile: Pay Down Tech Debt
Install CodeScene MCP: safeguard and uplift AI-generated code. Catch issues early with our IDE extension and CLI tool.

@codescene-delta-analysis codescene-delta-analysis Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Coverage Gates Passed
Overall Coverage: 99.5% (required = 95%)
New & Changed Code Coverage: 100% (required = 99%)

Review details by gate
  • Overall Coverage

    • Pass/Fail Reason:
      The overall coverage gate was checked for all code and meets the goal: 99.5% covered >= threshold = 95%
    • Action:
      You have 292 files with a sum of 3317 covered and 18 uncovered lines of code.
  • New & Changed Code Coverage

    • Pass/Fail Reason:
      New or changed code meets coverage goal: 100% covered >= threshold = 99%
    • Action:
      You modified 2 files, and covered 31 added/modified lines of code.

@stiwicourage
stiwicourage merged commit 71855b5 into develop May 24, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

refactor(Initialize-NovaModule): align with terminal-ux-design principles

1 participant